<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<title>Proxima Inspector</title>
		<link rel="icon" href="../icons/favicon.ico" />
		<meta name="viewport" content="width=device-width, height=device-height, initial-scale=1">
		<meta property="og:type" content="website">
		<meta name="description" property="og:description" content="Proxima Inspector lets you connect to your live game from a web browser to inspect and edit any property. Just like the Unity editor!">
		<meta name="image" property="og:image" content="../images/proxima-1200x630.png">
		<meta http-equiv="content-security-policy" content="">
		<link href="../_app/immutable/assets/_layout-1f0a7e97.css" rel="stylesheet">
		<link href="../_app/immutable/assets/_layout-6847360b.css" rel="stylesheet">
		
		
		
		
		
		
		
		
		
		
		
	</head>
	<body>
		<div>


<div class="flex flex-col items-center text-gray-300 w-full min-h-screen bg-[#222]"><div class="flex w-full justify-center items-start bg-[#111] text-white fixed z-20"><div class="flex grow justify-between items-center max-w-[1600px] p-4"><a href="https://www.unityproxima.com"><img src="../images/proxima_logo.png" class="w-[150px]" alt="Logo"></a>
            <button class="lg:hidden"><img class="w-10" src="../icons/menu.png" alt="Menu"></button>
            <div class="flex gap-10 items-center max-lg:hidden">
<a href="https://assetstore.unity.com/publishers/72095?aid=1101lqSYn" class="text-xl font-logo" referrerpolicy="origin" target="_blank" rel="external">Store</a>
                
<a href="https://app.unityproxima.com/connection" class="text-xl font-logo" referrerpolicy="origin" target="_blank" rel="external">Demo</a>
                
                <a class="text-xl font-logo" href="../docs.html">Docs</a>
                
<a href="https://discord.gg/VM9cWJ9rjH" class="" referrerpolicy="origin" target="_blank" rel="external"><img width="100px" class="mt-1" src="../icons/discord.png" alt=""></a></div></div>
        </div>

    <div class="pt-[83px] w-full h-full flex flex-col items-center"><div class="w-full flex flex-col items-start min-h-screen max-w-[1600px] px-4"><button class="text-white font-body pt-5 lg:hidden">Go to page &gt;</button>
    <div class="flex w-full min-h-full relative"><div class="h-full fixed border-r-orange-400 bg-[#222] border-r-2 max-lg:hidden"><div class="flex pt-10 flex-col w-[300px] gap-2 border-[#21a6f0] min-h-0 h-full overflow-auto"><b class="text-orange-400">Getting Started</b>
                <a href="../docs.html" class="svelte-yue6wq">Installation</a>
                <a href="../docs/features.html" class="svelte-yue6wq">Feature Overview</a>

                <b class="text-orange-400 mt-5">Connection</b>
                <a href="../docs/supported_platforms.html" class="svelte-yue6wq">Supported Platforms</a>
                <a href="../docs/connect.html" class="svelte-yue6wq">Connect to Your Game</a>
                <a href="../docs/security.html" class="svelte-yue6wq">Security Considerations</a>
                <a href="../docs/all_config.html" class="svelte-yue6wq">All Configuration Options</a>

                <b class="text-orange-400 mt-5">Inspector</b>
                <a href="../docs/inspector.html" class="svelte-yue6wq">GameObject Inspector</a>
                <a href="../docs/buttons.html" class="svelte-yue6wq">Adding Buttons</a>
                <a href="../docs/faq.html" class="svelte-yue6wq">Frequently Asked Questions</a>

                <b class="text-orange-400 mt-5">Logs</b>
                <a href="../docs/logs.html" class="svelte-yue6wq">Log Viewer</a>
                <a href="../docs/viewing_logs_offline.html" class="svelte-yue6wq">Viewing Logs Offline</a>

                <b class="text-orange-400 mt-5">Console</b>
                <a href="../docs/console.html" class="svelte-yue6wq">Console Window</a>
                <a href="../docs/console_built_in.html" class="svelte-yue6wq">Built-in Commands</a>
                <a href="../docs/console_custom.html" class="svelte-yue6wq">Custom Commands</a>

                <b class="text-orange-400 mt-5">Extras</b>
                <a href="../docs/deeplinks.html" class="svelte-yue6wq">Deep Links</a>

                <div class="h-[200px] shrink-0"></div></div></div>

        
        <div class="flex flex-col w-full lg:pl-10 py-10 lg:ml-[300px]"><div class="doc flex flex-col gap-5 svelte-yue6wq"><h1>Security Considerations</h1>

<p>Proxima Inspector is a powerful tool that can be used to control and debug your game. It is important to understand the security implications when using Proxima Inspector.
    Potentially any information in your game can be read with Proxima, or by anyone eavesdropping on your connection if encryption is not enabled.</p>
<p>To protect your game from unwanted access, follow the guidelines on this page.</p>

<h2 class="text-zinc-100 text-xl mt-5">Secure Configuration</h2>
<p>At a glance, this is what the most secure configuration of Proxima looks like:</p>

<img src="../docs/secure-config.png" alt="Secure Proxima Component Configuration">

<div class="bg-gray-800 p-5 text-zinc-300"><p class="font-bold">Notice that:</p>
    <ul class="list-decimal ml-5 leading-8"><li>Use Https is checked.</li>
        <li>No password is specified.</li>
        <li>Run On Enable is disabled.</li>
        <li>Instantiate Connect UI is enabled.</li></ul></div>

<p>The rest of this page will go over each of these options.</p>

<h2 class="text-zinc-100 text-xl mt-5">Use Https</h2>

<p>HTTPS is a protocol for secure communication over a network. It is used to encrypt data sent between your game and Proxima Inspector.</p>

<p>Enabling HTTPS is easy. Simply check the <b>Use HTTPS</b> box on the Proxima Inspector component.
    You may also need to add a new rule to your firewall to allow HTTPS traffic on your configured port.</p>

<h2 class="text-zinc-100 text-xl mt-5">(Optional) TLS Certificate</h2>

<p>HTTPS requires a TLS certificate to encrypt data. Proxima Inspector uses a self-signed certificate by default, which is not trusted by most browsers.
    The first time you try to access Proxima Inspector, you may see a warning like this that the certificate is not trusted.</p>

<img src="../docs/browser_warning.png" alt="Chrome certificate warning">

<p>This is normal, and you can safely bypass the warning by clicking &quot;Advanced -&gt; Proceed&quot;. Your browser is warning you that it cannot validate the identity of the server,
    but if you are connecting directly to your device by IP address, then you can be sure that you are connecting to the correct server.
</p>

<p>If you want to use your own certificate, import the PFX file and assign it to the <b>Certificate</b> property of the Proxima Inspector component.
</p>

<h2 class="text-zinc-100 text-xl mt-5">Password Security</h2>

<p>Proxima Inspector uses a password to authenticate your connection. If you type a password into the Proxima Inspector component, you will see this warning:</p>

<img src="../docs/password-warning.png" alt="Password warning">

<p>Unity assets, including your Proxima Inspector configuration <b>are not secured</b> and can be data mined by players easily. Instead of entering a password,
    it is recommended to have a user interface in which the player can create a password for Proxima to use at runtime. Alternatively, you can
    design an interface to display a random password on the screen.</p>

<p>The Proxima package includes a Connect UI prefab that you can use. To use it:
</p><ul class="list-decimal ml-5 leading-8"><li>Check <b>Instantiate Connect UI</b>.</li>
    <li>Clear the <b>Password</b> field.</li>
    <li>Uncheck <b>Run on Enable</b>. This will prevent Proxima from trying to start automatically.</li>
    <li>Run the game and press Proxima logo <img class="w-[25px] ml-2 mr-2 inline" src="../icons/proxima_icon_32x32.png" alt=""> on the bottom-right to show and hide the Connect UI.</li></ul>

<img src="../docs/connect-ui.png" alt="Proxima Connect UI"></div></div></div>
</div>
        <div class="h-[200px] flex flex-col"><p class="text-gray-400 m-10">© 2023 Virtual Maker Corporation</p></div></div></div>


		
	</div>
	</body>
</html>
